Refactor documentation structure for issue #1043 #1199
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to bc8442f in 33 seconds
More details
- Looked at
2922lines of code in37files - Skipped
153files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. docs/integrations/index.rst:3
- Draft comment:
The title 'Documentation' might be misleading as this section specifically deals with integrations. Consider renaming it to something more specific like 'Integration Documentation' or 'Integration Guides'. - Reason this comment was not posted:
Confidence changes required:50%
The PR refactors the documentation structure, which is a non-functional change. The changes are mostly related to restructuring the documentation files and ensuring links and references are correct. The PR description indicates that the changes have been tested for rendering and link correctness. The added files seem to be related to documentation and environment setup, which aligns with the PR's goal. There are no apparent code changes that would affect functionality, so the review should focus on the documentation structure and content.
2. hamilton/env1/share/jupyter/labextensions/jupyterlab-plotly/static/third-party-licenses.json:7
- Draft comment:
Avoid logging or exposing sensitive information such as license texts inappropriately. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:
License texts are generally not considered sensitive information. They are often included in software distributions to comply with open-source license requirements. The comment seems to misunderstand the nature of license texts, which are meant to be publicly accessible.
There might be specific contexts where license texts could be considered sensitive, but this is unlikely. The comment does not provide any specific reasoning or context for why these license texts would be sensitive.
Given the context of software development and open-source licenses, it is reasonable to assume that license texts are not sensitive information. The comment does not provide sufficient justification for its claim.
The comment should be deleted as it incorrectly categorizes license texts as sensitive information.
Workflow ID: wflow_tZmsJI0sn5vQAOCQ
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
|
@skrawcz Done ! |
I don't see any updates? |
|
@Bhabuk10 we need to resolve the warnings for the build to pass before I can see what documentation looks like - https://readthedocs.org/projects/hamilton/builds/26045579/ It seems like some TOC files can't be read. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
This pull request aims to improve the structure of the Hamilton documentation, enhancing clarity and usability as the documentation grows.
Changes
Refactored the documentation structure by separating the "Integrations" section into:
How I tested this
docsfolder to ensure that the new structure is clear and that all links and references work correctly.Notes
Checklist